docs: add task-oriented guide for the nebari-app Helm chart - #182
Merged
Conversation
The nebari-app library chart ships a thorough reference README, but there was no end-to-end walkthrough tying it to the operator flow and the software-pack-template examples, and the README was not linked from the docs tree. Add docs/using-the-nebari-app-chart.md: a step-by-step path from an empty consumer chart to a running, operator-managed app (add dependency -> values -> template -> opt-in namespace -> validate -> install -> verify), plus a troubleshooting table. It links out to the chart README for the template contract and to software-pack-template for full examples rather than duplicating them. Wire up discoverability: link the guide from the Quick Start 'Next Steps' and add a reciprocal pointer from charts/nebari-app/README.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a task-oriented guide for the
nebari-appHelm library chart, and makes the existing chart docs discoverable from the docs tree.The chart already ships a solid reference README (
charts/nebari-app/README.md) covering the template contract, required fields,mergeOverwrite, and multi-app usage. What was missing:software-pack-templateexamples, anddocs/- it was buried undercharts/.Changes
docs/using-the-nebari-app-chart.md(new) - a step-by-step path from an empty consumer chart to a running, operator-managed app: add the dependency -> put the spec invalues.yaml-> render via thenebari-app.nebariApptemplate -> opt the namespace in -> validate (helm template+kubectl apply --dry-run=server) -> install -> verify conditions. Ends with a troubleshooting table (required-field render errors,port >= 1, namespace-not-opted-in, CRD missing,AuthReady=False). It links out to the chart README for the template contract and tosoftware-pack-templatefor full runnable examples rather than duplicating them.docs/quickstart.md- the Quick Start deploys the first app as hand-written YAML; added a "Next Steps" link to the new guide as the "now package it as a reusable Software Pack" path.charts/nebari-app/README.md- a reciprocal pointer at the top: newcomers start with the walkthrough, the README stays the reference.Test plan
../charts/nebari-app/README.md,configuration-reference.md,api-reference.md,quickstart.md, and the reciprocal../../docs/...).